Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Linter: Warn about using non-fallible APIs for Lazy and Mapping #2045

Merged
merged 14 commits into from
Jan 10, 2024
Merged

Linter: Warn about using non-fallible APIs for Lazy and Mapping #2045

merged 14 commits into from
Jan 10, 2024

Conversation

jubnzv
Copy link
Member

@jubnzv jubnzv commented Jan 5, 2024 •
edited
Loading

Summary

Closes #2017

  • [n] y/n | Does it introduce breaking changes?
  • [n] y/n | Is it dependent on the specific version of cargo-contract or pallet-contracts?

Add a new lint for ink_linting_extra.

Description

This PR adds a new lint for ink_linting_extra. It warns about usage of the non-fallible API for Mapping and Lazy which potentially can lead to overflow of the static buffer.

Checklist before requesting a review

  • My code follows the style guidelines of this project
  • I have added an entry to CHANGELOG.md
  • I have commented my code, particularly in hard-to-understand areas
  • I have added tests that prove my fix is effective or that my feature works
  • Any dependent changes have been merged and published in downstream modules

@jubnzv
feat: Lint skeleton and tests for use-ink#2017
f47cda6
@jubnzv
feat: Basic checks for primitive types only
a1b1bf3
@jubnzv
Merge remote-tracking branch 'origin/master' into 2017-non-safe-apis
8e2137f
@jubnzv
feat: Recursive checks if nested types have statically known encoded …
7cf6603 
…size

Improve the heuristcs to check if nested types in ADTs, tuples and
arrays have statically encoded types, and therefore should not be
reported.

This removes false positives on the default ink types like `AccountId`
(alias to `[u8; 32]`).
@codecov-commenter
Copy link

codecov-commenter commented Jan 5, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (48ee5f5) 53.48% compared to head (2abfbd4) 53.49%.
Report is 4 commits behind head on master.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master    #2045      +/-   ##
==========================================
+ Coverage   53.48%   53.49%   +0.01%     
==========================================
  Files         221      221              
  Lines        6982     6982              
  Branches     3082     3082              
==========================================
+ Hits         3734     3735       +1     
+ Misses       3248     3247       -1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 5, 2024 •
edited
Loading

🦑 📈 ink! Example Contracts ‒ Changes Report 📉 🦑

These are the results when building the integration-tests/* contracts from this branch with cargo-contract and comparing them to ink! master:

Contract Upstream Size (kB) PR Size (kB) Diff (kB) Diff (%) Change
basic-contract-caller 3.207 3.207 0 0 ➖
basic-contract-caller/other-contract 1.581 1.581 0 0 ➖
call-builder-return-value 8.904 8.904 0 0 ➖
call-runtime 2.013 2.013 0 0 ➖
conditional-compilation 1.453 1.453 0 0 ➖
contract-storage 7.336 7.336 0 0 ➖
contract-terminate 1.336 1.336 0 0 ➖
contract-transfer 1.693 1.693 0 0 ➖
custom-allocator 7.652 7.652 0 0 ➖
dns 7.321 7.321 0 0 ➖
e2e-call-runtime 1.302 1.302 0 0 ➖
e2e-runtime-only-backend 1.879 1.879 0 0 ➖
erc1155 14.123 14.129 0.006 0.0424839 📈
erc20 6.918 6.918 0 0 ➖
erc721 9.816 9.816 0 0 ➖
events 5.006 5.006 0 0 ➖
flipper 1.637 1.637 0 0 ➖
incrementer 1.504 1.504 0 0 ➖
lang-err-integration-tests/call-builder-delegate 2.561 2.561 0 0 ➖
lang-err-integration-tests/call-builder 5.087 5.087 0 0 ➖
lang-err-integration-tests/constructors-return-value 1.987 1.987 0 0 ➖
lang-err-integration-tests/contract-ref 4.568 4.568 0 0 ➖
lang-err-integration-tests/integration-flipper 1.815 1.815 0 0 ➖
lazyvec-integration-test 4.553 4.553 0 0 ➖
mapping-integration-tests 7.919 7.919 0 0 ➖
mother 12.756 12.756 0 0 ➖
multi-contract-caller 6.155 6.155 0 0 ➖
multi-contract-caller/accumulator 1.378 1.378 0 0 ➖
multi-contract-caller/adder 1.908 1.908 0 0 ➖
multi-contract-caller/subber 1.928 1.928 0 0 ➖
multisig 21.621 21.621 0 0 ➖
payment-channel 5.653 5.653 0 0 ➖
sr25519-verification 1.148 1.148 0 0 ➖
static-buffer 1.649 1.649 0 0 ➖
trait-dyn-cross-contract-calls 2.706 2.706 0 0 ➖
trait-dyn-cross-contract-calls/contracts/incrementer 1.549 1.549 0 0 ➖
trait-erc20 7.294 7.294 0 0 ➖
trait-flipper 1.453 1.453 0 0 ➖
trait-incrementer 1.614 1.614 0 0 ➖
upgradeable-contracts/delegator 3.152 3.152 0 0 ➖
upgradeable-contracts/delegator/delegatee 1.613 1.613 0 0 ➖
upgradeable-contracts/set-code-hash 1.747 1.747 0 0 ➖
upgradeable-contracts/set-code-hash/updated-incrementer 1.726 1.726 0 0 ➖
wildcard-selector 2.852 2.852 0 0 ➖

Link to the run | Last update: Wed Jan 10 16:55:27 CET 2024

@jubnzv jubnzv marked this pull request as ready for review January 5, 2024 15:19
@jubnzv jubnzv requested a review from xermicus January 5, 2024 15:20
xermicus
xermicus reviewed Jan 8, 2024
View reviewed changes
Copy link
Contributor

@xermicus xermicus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this goes into the right direction.

linting/extra/src/non_fallible_api.rs Outdated Show resolved Hide resolved
xermicus
xermicus approved these changes Jan 9, 2024
View reviewed changes
Copy link
Contributor

@xermicus xermicus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jubnzv jubnzv merged commit 3db1c27 into use-ink:master Jan 10, 2024
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@xermicus xermicus xermicus approved these changes

@cmichi cmichi Awaiting requested review from cmichi cmichi is a code owner

@ascjones ascjones Awaiting requested review from ascjones ascjones is a code owner

@SkymanOne SkymanOne Awaiting requested review from SkymanOne

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Linter: Warn about using non-fallible APIs for Lazy and Mapping
3 participants
@jubnzv @codecov-commenter @xermicus